Remove narratives, trends, geo - #256
Conversation
There was a problem hiding this comment.
Do we still need this file?
it would be good to have a single source of truth.
i see there is another version of this swagger file here in the API
https://github.com/cfpb/api/blob/gh-pages/swagger-config.yaml
should this narratives API PR remove the endpoints for trends and geo too?
There was a problem hiding this comment.
It looks like the cfpb/api
https://github.com/cfpb/api/blob/gh-pages/ccdb/api.md#L7-L8
references ccdb5-api's own GH-pages branch through this:
https://github.com/cfpb/ccdb5-api/blob/gh-pages/documentation/swagger-initializer.js#L6
cfpb/api's swagger file appears to be stale and unused and we should probably delete it.
There was a problem hiding this comment.
oh, interesting, yeah I was assuming I'd need to do that work on the gh-pages branch, but looks like it's just done in this file.
2 participants
Companion to cfpb/ccdb5-ui#630
Summary
/geo/statesand/trendsendpoints, plus narrative-related fields/filters (has_narrative,complaint_what_happened) from search, serializers, defaults, and exports.fieldtoallinstead of narrative text.swagger-config.yaml) to match the remaining API surface so public docs stay accurate (this file is the source loaded by https://cfpb.github.io/ccdb5-api/documentation/).Test plan
/,/_suggest_company,/_suggest_zip, and/{id}still work/geo/statesand/trendsreturn 404has_narrative/ narrative fields are no longer accepted or returned